Package com.netscape.certsrv.key

Interface KeyRequestResource

@Path("agent/keyrequests")
public interface KeyRequestResource

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	approveRequest(RequestId id)
jakarta.ws.rs.core.Response	cancelRequest(RequestId id)
jakarta.ws.rs.core.Response	getRequestInfo(RequestId id)	Used to retrieve key request info for a specific request
jakarta.ws.rs.core.Response	listRequests(String requestState, String requestType, String clientKeyID, RequestId start, Integer pageSize, Integer maxResults, Integer maxTime, String realm)	Used to generate list of key requests based on the search parameters
jakarta.ws.rs.core.Response	rejectRequest(RequestId id)
jakarta.ws.rs.core.Response	submitRequest(RESTMessage data)
jakarta.ws.rs.core.Response	submitRequest(jakarta.ws.rs.core.MultivaluedMap<String,String> form)

Method Details

listRequests

@GET
jakarta.ws.rs.core.Response listRequests(@QueryParam("requestState")
 String requestState,
 @QueryParam("requestType")
 String requestType,
 @QueryParam("clientKeyID")
 String clientKeyID,
 @QueryParam("start")
 RequestId start,
 @QueryParam("pageSize")
 Integer pageSize,
 @QueryParam("maxResults")
 Integer maxResults,
 @QueryParam("maxTime")
 Integer maxTime,
 @QueryParam("realm")
 String realm)

Used to generate list of key requests based on the search parameters

submitRequest

@POST
@Consumes("application/x-www-form-urlencoded")
jakarta.ws.rs.core.Response submitRequest(jakarta.ws.rs.core.MultivaluedMap<String,String> form)
                                   throws Exception

Throws:

Exception

submitRequest

@POST
jakarta.ws.rs.core.Response submitRequest(RESTMessage data)
                                   throws Exception

Throws:

Exception

getRequestInfo

@GET
@Path("{id}")
jakarta.ws.rs.core.Response getRequestInfo(@PathParam("id")
 RequestId id)

Used to retrieve key request info for a specific request

approveRequest

@POST
@Path("{id}/approve")
jakarta.ws.rs.core.Response approveRequest(@PathParam("id")
 RequestId id)

rejectRequest

@POST
@Path("{id}/reject")
jakarta.ws.rs.core.Response rejectRequest(@PathParam("id")
 RequestId id)

cancelRequest

@POST
@Path("{id}/cancel")
jakarta.ws.rs.core.Response cancelRequest(@PathParam("id")
 RequestId id)